Table of Contents
🔗 Telemetry Collector
Tool to download CSV files of telemetry
🔗 Step by Step Usage
🔗 1. Retrieve a download token:
Perform a POST request to <tlm-manager-url>/collector/<missionId>/<satId> with a body in the following format:
{
"start": <required: time UTC in ISO format to begin data query>,
"end": <required: time UTC in ISO format to end data query>,
"points": [<required: array of points to include in the requested telemetry CSV>],
"src": [<required: array of sources to include in the requested telemetry CSV>],
"dn": <optional: boolean to return data with original spacecraft digital number, default false>,
"filter_empty": <optional: boolean to return data with or without empty rows, default true>,
"webhook": <optional: URL that accepts a POST>
}
This request will eventually redirect with a 302 status and a header:
location: download/<dlToken>
That location header's content is download/ followed by the dlToken needed in order to retrieve S3 download URLS. This dlToken is valid for 3 days.
🔗 When using a webhook:
If your webhook URL is public and configured properly, after making the request it will receive a POST request with a body either informing that the request for a download token has failed or containing that same location header and dlToken.
🔗 2. Retrieve a CSV download URL:
Perform a GET request to <tlm-manager-url>/collector/<missionId>/download/<dlToken>
This endpoint will return status: 202 in its response body until the download URL has been prepared, so it may need to be retried a few times.
Once the GET request returns status: 302, the response will have a header:
location: <S3 download URL>
That location header contains a signed S3 download URL which is valid for 1 minute, and when visited will download the telemetry in CSV format.
🔗 Sample POST Request Body
{
"start": "2022-04-01T00:00:00.000Z",
"end": "2022-04-07T00:00:00.000Z",
"points": [
"POINT_EXAMPLE"
],
"src": [
"SOURCE_EXAMPLE"
]
}